UI模块管理应用界面,用于操作加载HTML页面的原生窗口,调用系统原生控件等。由于此模块功能太多,现已根据功能分拆更新为Key、NativeUI、Navigator、Webview等,并对接口和功能做了一些优化调整,请使用新API。
方法:alert: 弹出系统提示框closeSplashscreen: 关闭程序启动界面closeWindow: 关闭原生窗口confirm: 弹出系统确认对话框createView: 创建新的原生控件对象createWaiting: 创建等待对话框createWindow: 创建新的原生窗口enumWindow: 枚举所有原生窗口findWindowByName: 查找指定名称的窗口getSelfWindow: 获取自身窗口isFullscreen: 判断应用当前是否全屏模式运行pickDate: 弹出日期选择界面pickTime: 弹出时间选择界面prompt: 弹出系统输入框setFullscreen: 设置应用是否全屏模式运行toast: 显示自动消失的消息对象:AnimationTypeShow: 一组用于定义页面或控件显示动画效果AnimationTypeClose: 一组用于定义页面或控件关闭的动画效果DateOption: JSON对象,选择日期界面设置的参数Metrics: JSON对象,窗口实际度量信息NView: 原生控件对象,用于操作页面中显示的原生控件NViewDock: 原生控件在窗口中停靠的方式NViewOption: JSON对象,原生控件元素要设置的参数NViewPosition: 原生控件在窗口中显示的位置NWaiting: NWaiting是等待控件对象,用于在界面中显示原生等待窗口NWaitingOption: JSON对象,原生等待控件要设置的参数NWindow: NWindow是窗口对象,用于操作加载html页面的原生窗口NWindowEvent: 窗口事件对象NWindowOption: JSON对象,原生窗口设置参数的对象PullToRefreshOption: JSON对象,原生窗口设置参数的对象TimeOption: JSON对象,选择时间界面设置的参数ToastOption: JSON对象,系统提示消息框要设置的参数Transform: 一组用于定义页面或控件变形的属性,暂不支持Transition: 一组用于定义页面或控件转换效果的属性回调方法:AlertCallback: 系统提示框确认的回调函数ConfirmCallback: 系统确认框操作的回调函数PromptCallback: 系统输入框操作的回调函数ToastCallback: 系统消息框消失时的回调函数PickDatetimeSuccessCallback: 选择日期或时间操作成功的回调函数PickDatetimeErrorCallback: 选择日期或时间操作失败的回调函数MetricsCallback: 获取控件或窗口实际度量信息回调函数EventCallback: 窗口事件的回调函数HistoryQueryCallback: 历史记录记录查询的回调函数PullToRefreshCallback: 窗口刷新操作的回调函数模块:5+功能模块(permissions)
{// ..."permissions":{// ..."UI": {"description": "访问系统原生窗口"}}}alert弹出系统提示框
void plus.ui.alert( message, alertCB, title, buttonCapture );说明:弹出系统样式提示对话框,可设置弹出对话框的标题、内容、按钮文字。此API非阻塞模式,用户点击提示框上的按钮需通过alertCB回调函数返回。
参数:message: (DOMString)必选 提示对话框上显示的内容alertCB: (AlertCallback)可选 点击提示对话框上按钮后的回调函数title: (DOMString)可选 提示对话框上显示的标题buttonCapture: (DOMString)必选 提示对话框上按钮的名称返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数 document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 弹出提示信息框plus.ui.alert( "Plus is ready!", function () {alert( "User pressed OK!" );}, "Hell0", "OK" );}Message notificationcloseSplashscreen关闭程序启动界面
void plus.ui.closeSplashscreen();说明:在某些情况下,程序启动后需要较长时间加载数据,为了避免界面显示空白内容,提高用户体验效果,这时可显示启动界面,直到数据加载完成后再关闭启动界面,通常在应用的首界面加载完成并更新显示内容后调用。
参数:无
返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 页面内容加载完成,关闭程序启动界面plus.ui.closeSplashscreen();} Message notificationcloseWindow关闭原生窗口
void plus.ui.closeWindow( win, aniClose, duration );说明:关闭已经打开的原生窗口。
参数:win: (DOMString)必选 要关闭的原生窗口可以是窗口对象,也可以是窗口的name值。aniClose: (AnimationTypeClose)可选 关闭原生窗口的动画效果duration: (Number)可选 关闭原生窗口的动画持续时间单位为ms,默认为窗口show方法设定的动画时间。返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function winAutoClose() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.baidu.com" ); // 百度主页nw.show(); // 显示窗口// 十秒后自动关闭setTimeout( function () {plus.ui.closeWindow( nw );}, 10000 );}confirm弹出系统确认对话框
void plus.ui.confirm( message, confirmCB, title, buttons );说明:弹出系统样式确认对话框,可设置弹出对话框的标题、内容、按钮数目及其文字。弹出的提示对话框为非阻塞模式,用户点击确认框上的按钮通过confirmCB回调函数返回。
参数:message: (DOMString)必选 确认对话框上显示的内容confirmCB: (ConfirmCallback)可选 点击确认对话框上按钮后的回调函数title: (DOMString)可选 确认对话框上显示的标题buttons: (DOMString[])可选 确认对话框上显示的按钮数组返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 弹出提示信息框plus.ui.confirm( "Are you sure ready?", function ( i ) {alert( (i==0)?"Yes!":"No!" );}, "Confirm", ["Yes","No"] );}Message notificationcreateView创建新的原生控件对象
NView plus.ui.createView( identity, options );说明:创建原生窗口显示元素,用于加载新的显示元素。可通过options设置原生窗口显示元素的属性。
参数:identity: (DOMString)必选 新创建显示元素的标识,需通过原生UI扩展注册options: (NViewOption)可选 新打开原生窗口显示元素的参数(如元素宽、高、位置等信息)返回值:NView: NView对象平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function createViewTest() {// 打开新窗口var nv = plus.ui.createView('Navigator',{position:'dock',dock:'top'});plus.ui.getSelfWindow().append( nv ); // 显示窗口}createWaiting创建等待对话框
NWaiting plus.ui.createWaiting( title, options );说明:在程序中创建并显示等待对话框。
参数:title: (DOMString)可选 等待框上显示的提示文字options: (NWaitingOption)可选 等待框的显示参数返回值:NWaiting: NWaiting对象平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 打开新窗口var w = plus.ui.createWaiting( "等待中..." );}等待对话框。createWindow创建新的原生窗口
NWindow plus.ui.createWindow( url, options );说明:创建原生窗口,用于加载新的系统原生窗口。可通过options设置原生窗口的属性。
参数:url: (DOMString)必选 创建窗口要打开的页面地址新打开原生窗口要加载html页面地址,可支持本地地址和网络地址。options: (NWindowOption)可选 新打开原生窗口的参数(如窗口宽、高、位置等信息)返回值:NWindow: NWindow对象平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function createWinTest() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.baidu.com" ); // 百度主页nw.show(); // 显示窗口}enumWindow枚举所有原生窗口
Array[NWindow] plus.ui.enumWindow();说明:枚举所有未关闭的原生窗口。返回窗口对象数组中按窗口打开先后顺序排列,即数组中第一个窗口对象用通常是应用默认开启的窗口。
参数:无
返回值:NWindow: NWindow数组对象平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function enumWindow() {// 打开新窗口var winary = plus.ui.enumWindow();var mwin = winary[0]; // 获取主窗口alert( "Main URL: " + mwin.url );}findWindowByName查找指定名称的窗口
NWindow plus.ui.findWindowByName( name );说明:在已打开的窗口列表中查找指定名称的窗口并返回。若没有查找到指定名称的窗口则返回null。对于应用的首页面,其窗口名称默认为应用的%APPID%。
参数:name: (DOMString)必选 要查找的窗口名称返回值:NWindow: NWindow对象平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 查找“test”窗口对象var tw = plus.ui.findWindowByName( "test" );if ( tw != null ) {alert( "Finded! " );}// 查找应用首页窗口对象var home = plus.ui.findWindowByName( plus.runtime.appid );}Find "test" WindowgetSelfWindow获取自身窗口
NWindow plus.ui.getSelfWindow();说明:获取当前运行脚本所属的原生窗口。
参数:无
返回值:NWindow: NWindow对象平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 打开新窗口var sw = plus.ui.getSelfWindow();alert( "I'am: " + sw.url );}Self WindowisFullscreen判断应用当前是否全屏模式运行
boolean plus.ui.isFullscreen( fullscreen );参数:无
返回值:Boolean: 当应用在全屏模式下运行时返回true,否则返回false。pickDate弹出日期选择界面
void plus.ui.pickDate( successCB, errorCB, options );说明:弹出系统日期选择界面,用于选择日期。用户完成选择后通过successCB回调函数返回,若用户取消选择则通过errorCB回调。
参数:successCB: (PickDatetimeSuccessCallback)必选 日期选择操作成功的回调函数errorCB: (PickDatetimeErrorCallback)可选 日期选择操作失败的回调函数options: (DateOption)可选 日期选择操作界面的参数返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 输入提示信息框plus.ui.pickDate( function ( d ) {alert( d.getFullYear() + "-" + (d.getMonth()+1) + "-" + d.getDate() );}, function ( e ) {}, {startYear:2010,endYear:} );}Pick DatepickTime弹出时间选择界面
void plus.ui.pickTime( successCB, errorCB, options );说明:弹出系统时间选择界面,用于选择时间。用户完成选择后通过successCB回调函数返回,若用户取消选择则通过errorCB回调。
参数:successCB: (PickDatetimeSuccessCallback)必选 时间选择操作成功的回调函数errorCB: (PickDatetimeErrorCallback)可选 时间选择操作失败的回调函数options: (TimeOption)可选 时间选择操作界面的参数返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 输入提示信息框plus.ui.pickTime( function ( d ) {alert( d.getHours()() + ":" + d.getMinutes() );}, function ( e ) {alert( "Pick time error: " + e.message );}, {is24Hour:true} );}Pick timeprompt弹出系统输入框
void plus.ui.confirm( message, promptCB, title, tip, buttons );说明:弹出系统样式输入对话框,可设置弹出对话框的标题、内容、提示输入信息、按钮数目及其文字。弹出的提示对话框为非阻塞模式,用户点击确认框上的按钮通过promptCB回调函数返回。
参数:message: (DOMString)必选 输入对话框上显示的内容promptCB: (PromptCallback)可选 点击输入对话框上按钮后的回调函数title: (DOMString)可选 输入对话框上显示的标题tip: (DOMString)可选 输入对话框上显示的提示文字buttons: (DOMString[])可选 输入对话框上显示的按钮数组返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 输入提示信息框plus.ui.confirm( "Please input your name:", function ( i, v ) {alert( (i==0)?"Name:"+v:"No input!" );}, "Input", ["Yes","No"] );}Message notificationsetFullscreen设置应用是否全屏模式运行
void plus.ui.setFullscreen( fullscreen );说明:当应用在全屏模式下运行时,将隐藏系统状态栏。通常游戏类应用在这种模式下运行。
参数:fullscreen: (Boolean)必选 是否全屏模式运行,true表示全屏模式运行,false表示非全屏模式运行返回值:void: 无toast显示自动消失的消息
void plus.ui.toast( message, options );说明:弹出系统样式提示消息框。弹出的提示对话框为非阻塞模式,显示指定时间后自动消失。
参数:message: (DOMString)必选 提示消息框上显示的文字内容options: (ToastOption)可选 提示消息框的设置参数返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.3+(支持)示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// 输入提示信息框plus.ui.toast( "I'am toast information!", {duration:"long"} );}Message notificationAnimationTypeShow一组用于定义页面或控件显示动画效果
常量:"none": (DOMString类型)无动画效果立即显示页面,无任何动画效果,页面显示默认的动画效果。对应关闭动画"none"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-in-right": (DOMString类型)从右侧横向滑动效果页面从屏幕右侧外向内横向滑动显示。对应关闭动画"slide-out-right"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-in-left": (DOMString类型)从上侧竖向滑动效果页面从屏幕上侧向内竖向滑动显示。对应关闭动画"slide-out-top"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-in-bottom": (DOMString类型)从下侧竖向滑动效果页面从屏幕下侧向内竖向滑动显示。对应关闭动画"slide-out-bottom"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"fade-in": (DOMString类型)从透明到不透明逐渐显示效果页面从完全透明到不透明逐渐显示。对应关闭动画"fade-out"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"zoom-out": (DOMString类型)从小到大逐渐放大显示效果页面在屏幕中间从小到大逐渐放大显示。对应关闭动画"zoom-in"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-x": (DOMString类型)以x轴从上到下翻转效果页面以x轴从上到下翻转显示。对应关闭动画"flip-rx"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-rx": (DOMString类型)以x轴从下到上翻转转效果页面以x轴从下到上翻转显示。对应关闭动画"flip-x"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-y": (DOMString类型)以y轴从左到右翻转效果页面以y轴从左到右翻转显示。对应关闭动画"flip-ry"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-ry": (DOMString类型)以y轴从右到左翻转效果页面以y轴从右到左翻转显示。对应关闭动画"flip-y"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"page-forward": (DOMString类型)向前翻书动画效果页面以向前翻书动画显示,翻书后显示新打开的页面。对应关闭动画"page-backward"。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)AnimationTypeClose一组用于定义页面或控件关闭的动画效果
常量:"none": (DOMString类型)无动画立即关闭页面,无任何动画效果。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-out-right": (DOMString类型)横向向右侧滑出屏幕动画页面从屏幕中横向向右侧滑动到屏幕外关闭。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-out-left": (DOMString类型)横向向左侧滑出屏幕动画页面从屏幕中横向向左侧滑动到屏幕外关闭。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-out-top": (DOMString类型)竖向向上侧滑出屏幕动画页面从屏幕中竖向向上侧滑动到屏幕外关闭。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"slide-out-bottom": (DOMString类型)竖向向下侧滑出屏幕动画页面从屏幕中竖向向下侧滑动到屏幕外关闭。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"fade-out": (DOMString类型)从不透明到透明逐渐隐藏动画页面从不透明到透明逐渐隐藏关闭。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"zoom-in": (DOMString类型)从大逐渐缩小关闭动画页面逐渐向页面中心缩小关闭。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-x": (DOMString类型)以x轴从上到下翻转动画页面以x轴从上到下翻转关闭,翻转后显示以前显示的页面。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-rx": (DOMString类型)以x轴从下到上翻转转动画页面以x轴从下到上翻转关闭,翻转后显示以前显示的页面。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-y": (DOMString类型)以y轴从左到右翻转动画页面以y轴从左到右翻转关闭,翻转后显示以前显示的页面。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"flip-ry": (DOMString类型)以y轴从右到左翻转动画页面以y轴从右到左翻转关闭,翻转后显示以前显示的页面。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)"page-backward": (DOMString类型)向后翻书动画页面以向后翻书动画关闭,翻书后显示以前显示的页面。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)DateOptionJSON对象,选择日期界面设置的参数
属性:title: (DOMString类型)日期选择界面的标题默认标题为当前的日期。
date: (DOMDate类型)日期选择界面默认显示的日期默认值为当前的日期。
startYear: (Number类型)日期选择界面起始的年份数字类型,如“1940”。
endYear: (Number类型)日期选择界面结束的年份数字类型,如“2024”,其值必须大于startYear,否则取系统默认值。
minDate: (DOMDate类型)日期选择界面显示的最小日期日期类型对象,其优先级高于startYear属性。
maxDate: (DOMDate类型)日期选择界面显示的最大日期日期类型对象,其值必须大于startYear,否则取系统默认值,优先级高于endYear属性。
popover: (JSON类型)时间日期选择界面弹出指示区域JSON类型对象,格式如{top:10;left:10;width:200;height:200;},所有值为像素值,左上坐标相对于容器webview的位置。如未设置此值,默认在屏幕居中显示。仅在iPad上有效。
MetricsJSON对象,窗口实际度量信息
属性:height: (Number类型)绝对像素值,窗口的高度left: (Number类型)绝对像素值,相对于屏幕或父容器左侧的偏移量top: (Number类型)绝对像素值,相对于屏幕或父容器上侧的偏移量width: (Number类型)绝对像素值,窗口的宽度NView原生控件对象,用于操作页面中显示的原生控件
方法:getMetrics: 获取窗口实际度量信息getMetrics获取窗口实际度量信息
vobj.getMetrics( callback );说明:用于获取原生控件的度量信息,包括控件的位置、大小等信息。获取成功后通过callback回调返回。
参数:callback: (MetricsCallback)必选 获取度量信息的回调函数返回值:void: 无示例:UI Examplevar vobj = null;// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {var nv = plus.ui.createView( "navigator", {top:"0px",width:"100%",height:"50px"} );plus.ui.getSelfWindow().append( nv ); // 显示窗口}function metricsTest() {// 获取控件信息nv.getMetrics( function ( m ) {alert( "Left: " + m.left + "\n Top: " + m.top );} );}NViewDock原生控件在窗口中停靠的方式
常量:"top": (DOMString类型)控件停靠则页面顶部"bottom": (DOMString类型)控件停靠在页面中底部"right": (DOMString类型)控件停靠在页面右侧"left": (DOMString类型)控件停靠在页面左侧NViewOptionJSON对象,原生控件元素要设置的参数
属性:id: (DOMString类型)控件的标识top: (DOMString类型)控件在所属窗口垂直向下的偏移量,可设置像素值或百分比,默认值为0pxleft: (DOMString类型)控件在所属窗口水平向右的偏移量,可设置像素值或百分比,默认值为0pxwidth: (DOMString类型)控件的宽度,可设置像素值或百分比,默认为控件内部计算的高度(参考扩展自定义控件)height: (DOMString类型)控件的高度,可设置像素值或百分比,默认为控件内部计算的高度(参考扩展自定义控件)position: (NViewPosition类型)控件的排版位置,默认值为"static"dock: (NViewDock类型)控件的停靠方式,默认值为"top"NViewPosition原生控件在窗口中显示的位置
常量:"static": (DOMString类型)控件在页面中正常定位,如果页面存在滚动条则随窗口内容滚动"absolute": (DOMString类型)控件在页面中绝对定位,如果页面存在滚动条不随窗口内容滚动"dock": (DOMString类型)控件在页面中停靠,停靠的位置通过dock属性进行定义NWaitingNWaiting是等待控件对象,用于在界面中显示原生等待窗口
方法:setTitle: 设置等待控件上显示的文字close: 关闭等待控件事件:onclose: 关闭等待控件事件setTitle设置等待控件上显示的文字
wobj.setTitle( title );说明:设置等待框上显示的文字信息,设置后文字内容将立即更新。
参数:title: (DOMString)必选 要设置的文本信息返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );var w = null;// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {w = plus.ui.createWaiting("请稍后");setTimeout( function() {w.setTitle( "正在更新" );}, 2000 );setTimeout( function() {w.close();}, 4000 );}close关闭等待控件
wobj.close();说明:将原生等待控件关闭。一个等待控件只能关闭一次,多次调用将无任何作用。
参数:无
返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );var w = null;// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {w = plus.ui.createWaiting("请稍后");}function closeWaiting() {if ( w == null ) {alert( "未创建等待框" );} else {w.close();}}onclose关闭等待控件事件
wobj.onclose = function () {alert( "Closed!" );};说明:function类型
等待框关闭时触发。当调用close方法或用户点击操作导致等待框关闭时触发。
示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );var w = null;// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {w = plus.ui.createWaiting("请稍后");w.onclose = function () {alert( "Closed!!" );}}function closeWaiting() {if ( w == null ) {alert( "未创建等待框" );} else {w.close();}}NWaitingOptionJSON对象,原生等待控件要设置的参数
属性:width: (DOMString类型)等待框背景区域的宽度,默认根据内容自动计算height: (DOMString类型)等待框背景区域的高度,默认根据内容自动计算color: (DOMString类型)等待框中文字的颜色颜色值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值,默认值为白色。
textalign: (DOMString类型)等待框中的文字的水平对齐方式对齐方式可选值包括:"left":水平居左对齐显示,"center":水平居中对齐显示,"right":水平居右对齐显示。默认值为水平居中对齐显示。
padding: (DOMString类型)等待框的内边距支持像素值和百分比,百分比相对于屏幕的宽计算,默认值为"3%"。
background: (DOMString类型)等待框显示区域的背景色背景色的值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值,默认值为rgba(0,0,0,0.8)。
style: (DOMString类型)等待框样式,可取值"black"、"white"black表示等待框为黑色雪花样式,通常在背景主色为浅色时使用;white表示等待框为白色雪花样式,通常在背景主色为深色时使用;仅在iOS平台有效,其它平台忽略此值,默认值为white。
平台支持Android - (不支持): 此属性不产生任何效果iOS - 4.5+ (支持): 支持"black"、"white"两种样式modal: (Boolen类型)等待框是否模态显示模态显示则用户不可操作直到等待框关闭,否则用户在等待框显示时也可操作,默认为true。
round: (Number类型)等待框显示区域的圆角,默认值为10pxpadlock: (Boolen类型)点击等待显示区域是否自动关闭,默认值为falseNWindowNWindow是窗口对象,用于操作加载html页面的原生窗口
方法:addEventListener: 添加事件监听器append: 在窗口中添加原生界面控件appendPreloadJsFile: 添加页面预先加载的js文件back: 窗口后退到上次加载的页面内容canBack: 查询窗口是否可后退到上次加载的页面内容canForward: 查询窗口是否可前进到上次加载的页面内容clear: 清空原生窗口加载的内容close: 关闭创建新的原生窗口endPullToRefresh: 关闭原生窗口刷新状态evalJS: 在窗口中执行脚本findViewById: 在界面中通过id查找控件对象forward: 窗口前进到上次加载的页面内容getMetrics: 获取窗口实际度量信息getOption: 获取窗口当前的属性值getTitle: 获取窗口加载页面的标题getUrl: 获取窗口加载页面的地址load: 窗口加载新的页面reload: 重新加载窗口当前显示的页面removeEventListener: 移除事件监听器setContentVisible: 设置页面内容是否可见setOption: 设置原生窗口的参数setPreloadJsFile: 设置页面预先加载的js文件setPullToRefresh: 设置窗口的下拉刷新功能setVisible: 设置窗口是否可见show: 显示创建新的原生窗口stop: 窗口停止加载页面内容addEventListener添加事件监听器
wobj.addEventListener( event, listener, capture );说明:为窗口添加事件监听器,当指定的窗口事件发生时,回调函数将触发。可多次调用为同一事件添加多个监听器,触发时按照添加的顺序先后调用。
参数:event: (NWindowEvent)必选 要监听的事件类型listener: (EventCallback)必选 监听的事件发生时调用的回调函数capture: (Boolean)可选 捕获事件流顺序,暂无效果返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function eventTest() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.test.com" );nw.addEventListener( "loaded", function () {alert( "New Window loaded!" );}, false );nw.show(); // 显示窗口}append在窗口中添加原生界面控件
void wobj.append( view );说明:将原生控件添加到界面中,随界面一起显示。控件只能添加到一个界面中,多次调用将无任何作用。
参数:view: (NView)必选 要添加的控件对象,需通过createView创建返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function createViewTest() {// 创建控件var nv = plus.ui.createView( "navigator" );plus.ui.getSelfWindow().append( nv ); // 显示控件}appendPreloadJsFile添加页面预先加载的js文件
wobj.appendPreloadJsFile( file );说明:添加页面加载时需要预先执行的js文件,以完成特殊的页面处理。在窗口页面跳转时也需要执行,添加多个js文件后将按照添加的先后顺序执行。
参数:file: (DOMString)必选 要预先载入的js文件地址,仅支持本地文件返回值:void: 无back窗口后退到上次加载的页面内容
void wobj.back();说明:窗口历史记录操作,后退到窗口上次加载的页面内容。如果窗口历史记录中没有可后退的页面则不触发任何操作。
参数:无
返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// Plus API}function goBack() {var nw = plus.ui.getSelfWindow();nw.back();}返回canBack查询窗口是否可后退到上次加载的页面内容
void wobj.canBack( queryCallback );说明:窗口历史记录操作,查询是否可后退到窗口上次加载的页面内容。查询成功将通过queryCallback回调方法返回结果。
参数:queryCallback: (HistoryQueryCallback)必选 历史记录查询操作回调函数返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// Plus API}function queryBack() {var nw = plus.ui.getSelfWindow();nw.canBack( function ( able ) {if ( able ) {alert( "可以后退" );} else {alert( "无法后退" );}} );}是否可后退canForward查询窗口是否可前进到上次加载的页面内容
void wobj.canForward( queryCallback );说明:窗口历史记录操作,查询是否可前进到窗口上次加载的页面内容。查询成功将通过queryCallback回调方法返回结果。
参数:queryCallback: (HistoryQueryCallback)必选 历史记录查询操作回调函数返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// Plus API}function queryForward() {var nw = plus.ui.getSelfWindow();nw.canForward( function ( able ) {if ( able ) {alert( "可以前进" );} else {alert( "无法前进" );}} );}是否可前进clear清空原生窗口加载的内容
void wobj.clear();说明:清除原生窗口的内容,用于重置重置原生窗口加载的内容,清除其加载的历史记录等内容。
参数:无
返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function clearWin() {// 清除自身窗口var nw = plus.ui.getSelfWindow();nw.clear();}close关闭创建新的原生窗口
void wobj.close( aniClose, duration );说明:关闭原生窗口,用于销毁创建的系统原生窗口。原生窗口窗口只能关闭一次,关闭窗口后不可再操作窗口对象,操作后将无任何效果。窗口关闭时默认会使用窗口打开时设置的相反动画效果,也可通过aniClose设置原生窗口关闭动画,仅能使用动画类型中的关闭动画效果。
参数:aniClose: (AnimationTypeClose)可选 关闭原生窗口的动画效果duration: (Number)可选 关闭原生窗口的动画持续时间单位为ms,默认为窗口show方法设定的动画时间。返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function closeWin() {// 关闭自身窗口var nw = plus.ui.getSelfWindow();nw.close(); // 关闭窗口}endPullToRefresh关闭原生窗口刷新状态
void wobj.endPullToRefresh();说明:通过setPullToRefresh方法可开启窗口的下拉刷新功能,当用户操作触发刷新回调事件后,可以通过此方法关闭窗口的刷新状态。关闭刷新状态后,用于依然可以通过下拉操作继续触发刷新事件。
参数:无
返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.5+(不支持): 暂不支持,建议通过web技术实现示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function closeWin() {// 关闭自身窗口var nw = plus.ui.getSelfWindow();nw.close(); // 关闭窗口}evalJS在窗口中执行脚本
void wobj.evalJS( js );说明:可在窗口中运行脚本,实现跨窗口间的数据操作。
参数:options: (DOMString)必选 要在窗口中运行的脚本返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function evalJSTest() {// 查找到只指定的界面var nw = plus.ui.findWindowByName( "test" );nw.evalJS( "var bt = document.getElementById('bt'); bt.value='NewValue';" );}findViewById在界面中通过id查找控件对象
void wobj.findViewById( id );说明:在当前界面中查找控件对象,并返回控件对象的引用。其中控件的id在创建时通过NViewOption中的id字段设置。如果没有找到则返回null
参数:id: (DOMString)必选 要查找控件的id值返回值:NView: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIvar sw = null;function onPlusReady() {sw = plus.ui.getSelfWindow();// 创建控件var nv = plus.ui.createView( "navigator", {id:"nav"} );sw.append( nv ); // 显示控件}var fnv = null;function findTest() {fnv = sw.findViewById( "nav" );// 可通过fnv对象操作导航控件}forward窗口前进到上次加载的页面内容
void wobj.forward();说明:窗口历史记录操作,前进到窗口上次加载的页面内容。如果窗口历史记录中没有可前进的页面则不触发任何操作。
参数:无
返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {// Plus API}function goForward() {var nw = plus.ui.getSelfWindow();nw.forward();}返回getMetrics获取窗口实际度量信息
void wobj.getMetrics( callback );说明:用于获取窗口实际度量信息,包括窗口的位置、大小等信息。获取度量信息成功后通过callback回调返回。/隐藏,再次调用显示/隐藏则无任何作用。
参数:callback: (MetricsCallback)必选 获取度量信息的回调函数返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function metricsTest() {// 获取窗口信息var sw = plus.ui.getSelfWindow();sw.getMetrics( function ( m ) {alert( "Left: " + m.left + "\n Top: " + m.top );} );}getOption获取窗口当前的属性值
NWindowOption wobj.getOption();说明:获取原生窗口的属性,如窗口位置、大小等信息。
参数:无
返回值:NWindowOption: NWindowOption对象示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function optionTest() {var nw = plus.ui.getSelfWindow();alert( nw.getOption().left );}getTitle获取窗口加载页面的标题
DOMString wobj.getTitle();说明:标题为窗口加载的html页面head节点下title节点中的文本内容,当窗口内容发生页面内跳转时可通过窗口触发的“loaded”事件中调用此方法来获取跳转后页面的标题。如果页面中午title节点则返回空字符串。
参数:无
返回值:DOMString: 窗口加载页面的标题示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function test() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.baidu.com" );nw.addEventListener( "loaded", function () {alert( "标题:"+nw.getTitle() );}, false );nw.show(); // 显示窗口}打开新页面getUrl获取窗口加载页面的地址
DOMString wobj.getUrl();说明:当窗口内容发生页面内跳转时可通过窗口触发的“loaded”事件中调用此方法来获取跳转后页面的地址。
参数:无
返回值:DOMString: 窗口加载页面的地址示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function test() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.baidu.com" );nw.addEventListener( "loaded", function () {alert( "跳转地址:"+nw.getUrl() );}, false );nw.show(); // 显示窗口}打开新页面load窗口加载新的页面
void wobj.load( url );说明:触发原生窗口加载新的页面地址。如果新设置的url地址无效将导致页面显示失败。
参数:url: (DOMString)必选 要加载的新的页面地址返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function jumpUrl() {var nw = plus.ui.getSelfWindow();nw.load( "https://www.test.com" ); // 跳转到新的页面}跳转到新页面reload重新加载窗口当前显示的页面
void wobj.reload( force );说明:触发原生窗口重新加载当前显示的页面地址。如果当前页面未加载完则停止并重新加载,如果当前没有加载任何页面则无响应。
参数:force: (Boolean)必选 是否强制不使用本地缓存为加速页面加载速度,默认在重新加载时会使用缓存,若force设置为true则不使用缓存,重新从服务器加载所有页面内容。返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function refresh() {var nw = plus.ui.getSelfWindow();nw.reload( true );}重新加载removeEventListener移除事件监听器
wobj.removeEventListener( event, listener );说明:从窗口移除指定的事件监听器。若没有查找到对应的事件监听器,则无任何作用。
参数:event: (NWindowEvent)必选 要移除的事件类型listener: (EventCallback)必选 要移除回调函数对象返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function onloaded () {alert( "New Window loaded!" );}var nw = null;function eventTest() {// 打开新窗口nw = plus.ui.createWindow( "https://www.test.com" );nw.addEventListener( "loaded",onloaded, false );// 10s后显示窗口setTimeout( function () {nw.show();}, 10000 );}function removeEvent () {nw.removeEventListener( "loaded", onloaded );}setContentVisible设置页面内容是否可见
void wobj.setContentVisible( visible );说明:在某些特殊情况下需要对页面内容进行预处理,如对内容进行过滤转换,为了不让内容在转换完成之前显示,则可先通过此方法设置页面内容不可见,带内容转换完成后再设置页面内容可见。
参数:visible: (Boolean)必选 设置页面是否可见的值返回值:void: 无setOption设置原生窗口的参数
void wobj.setOption( options );说明:设置原生窗口的属性,如窗口位置、大小等信息。
参数:options: (NWindowOption)必选 要设置新的窗口属性返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function moveWinTo() {var nw = plus.ui.getSelfWindow();nw.setOption( {left:50%} ); // 水平移动窗口到屏幕中间位置}移动窗口setPreloadJsFile设置页面预先加载的js文件
wobj.setPreloadJsFile( file );说明:某些页面加载时预先执行插入的js文件,以完成特殊的页面处理。在窗口页面跳转时也需要执行,设置新的js文件后将清空之前设置的值。
参数:file: (DOMString)必选 要预先载入的js文件地址,仅支持本地文件返回值:void: 无setPullToRefresh设置窗口的下拉刷新功能
wobj.setPullToRefresh( PullToRefreshOption options, PullToRefreshCallback refreshCB );说明:窗口自带下拉刷新功能,当用户触发刷新操作时通过refreshCB函数通知应用执行刷新操作。此时窗口进入刷新状态并一直显示下拉刷新控件,直到调用endPullToRefresh方法退出刷新状态。
参数:options: (PullToRefreshOption)必选 设置下拉刷新功能的配置信息,如下拉区域的高度、上面显示的内容等refreshCB: (PullToRefreshCallback)可选 用户触发刷新操作时的回调函数返回值:void: 无平台支持:Android- 2.2+(支持)iOS- 4.5+(不支持): 暂不支持,建议通过web技术实现示例:Pull to refreshvar ws=null;var list=null;// 扩展API加载完毕,现在可以正常调用扩展API function plusReady(){ws=plus.ui.getSelfWindow();ws.setPullToRefresh({support:true,height:"100px",contentdown:{caption:"下拉可以刷新"},contentover:{caption:"释放立即刷新"},contentrefresh:{caption:"正在刷新..."}},onRefresh);}// 判断扩展API是否准备,否则监听"plusready"事件if(window.plus){plusReady();}else{document.addEventListener("plusready",plusReady,false);}// DOM构建完成获取列表元素document.addEventListener("DOMContentLoaded",function(){list=document.getElementById("list");})// 刷新页面function onRefresh(){setTimeout(function(){if(list){var item=document.createElement("li");item.innerHTML="New Item "+dateToStr(new Date())+"";list.insertBefore(item,list.firstChild);}ws.endPullToRefresh();},2000);}li {padding: 1em;border-bottom: 1px solid #eaeaea;}li:active {background: #f4f4f4;}Initializ List Item 1Initializ List Item 2Initializ List Item 3Initializ List Item 4Initializ List Item 5Initializ List Item 6Initializ List Item 7Initializ List Item 8Initializ List Item 9Initializ List Item 10setVisible设置窗口是否可见
void wobj.setVisible( visible );说明:用于隐藏原生窗口,减少显示的窗口数目,可降低占用的系统资源,通常在打开新窗口后隐藏不需要显示的窗口。窗口隐藏后,如果要显示则必须调用此方法将窗口显示,否则将导致窗口不显示。如果当前窗口已经显示/隐藏,再次调用显示/隐藏则无任何作用。
参数:visible: (Boolean)必选 设置窗口是否可见的值返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function visibleTest() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.test.com" );var sw = plus.ui.getSelfWindow();nw.show(); // 显示窗口sw.setVisible( false ); // 隐藏当前窗口}show显示创建新的原生窗口
void wobj.show( aniShow, duration, assWin );说明:显示原生窗口,用于显示创建的系统原生窗口。原生窗口窗口只能显示一次,多次调用show方法将无任何作用。可通过aniShow设置原生窗口显示动画。
参数:aniShow: (AnimationTypeShow)可选 显示原生窗口的动画效果duration: (Number)可选 显示原生窗口的动画持续时间单位为ms,默认为600ms。assWin: (DOMString)可选 新打开原生窗口动画需要关联的窗口名称返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function createWinTest() {// 打开新窗口var nw = plus.ui.createWindow( "https://www.baidu.com" ); // 百度主页nw.show( "slide-in-right", 500 ); // 显示窗口,动画时间为500毫秒}stop窗口停止加载页面内容
void wobj.stop();说明:触发原生窗口停止加载页面内容。如果已经加载部分内容则显示部分内容,如果加载完成则显示全部内容。
参数:无
返回值:void: 无示例:UI Example// 扩展API加载完毕后调用onPlusReady回调函数document.addEventListener( "plusready", onPlusReady, false );// 扩展API加载完毕,现在可以正常调用扩展APIfunction onPlusReady() {}function stopLoad() {var nw = plus.ui.getSelfWindow();nw.stop();}停止加载NWindowEvent窗口事件对象
常量:"close": (DOMString类型)当窗口关闭时触发此事件"loading": (DOMString类型)当窗口开始加载新内容时触发此事件"loaded": (DOMString类型)当窗口内容加载完成时触发此事件"failed": (DOMString类型)当窗口内容加载失败时触发此事件"back": (DOMString类型)设备“返回”按钮按键事件"menu": (DOMString类型)设备“菜单”按钮按键事件"search": (DOMString类型)设备“搜索”按钮按键事件"volumeup": (DOMString类型)设备“音量+”按钮按键事件"volumedown": (DOMString类型)设备“音量-”按钮按键事件NWindowOptionJSON对象,原生窗口设置参数的对象
属性:background: (DOMString类型)窗口的背景颜色窗口空白区域的背景,设置了background则窗口为独占模式显示(占整个屏幕区域),否则为非独占模式,目前仅支持背景色的设置(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值。
bottom: (DOMString类型)窗口垂直向上的偏移量支持百分比、像素值,当设置了top和height值时,此属性值忽略;当设置top和bottom属性则自动计算窗口的高度。
bounce: (DOMString类型)窗口遇到边框是否有反弹效果可取值:none表示没有反弹效果;vertical表示垂直方向有反弹效果;horizontal表示水平方向有反弹效果;all表示垂直和水平方向都有反弹效果。
平台支持Android - (不支持)iOS - (支持): 默认值为none,垂直和水平方向都没有反弹效果。height: (DOMString类型)窗口的高度支持百分比、像素值,默认为100%。
left: (DOMString类型)窗口水平向右的偏移量支持百分比、像素值,默认值为0px。
margin: (DOMString类型)窗口的边距用于定位窗口的位置,支持auto,auto表示居中。若设置了left、right、top、bottom则对应的边距值失效。
name: (DOMString类型)窗口的名称作为窗口的标识,可用于窗口的查找。
opacity: (Number类型)窗口的不透明度0为全透明,1为不透明,默认值为1,即不透明。
平台支持Android - 2.2+ (支持): 需Android4.0及以上平台才支持,Android4.0以前平台忽略此属性。iOS - 4.3+ (支持)right: (DOMString类型)窗口水平向左的偏移量支持百分比、像素值,默认无值。当设置了left和width值时,此属性值忽略;当设置left和right属性则自动计算窗口的宽度。
scalable: (Boolean类型)窗口是否可缩放默认值为true,即可缩放。窗口设置为可缩放(scalable:true)时,用户可通过双指操作放大或缩小页面,这时html页面可通过meta节点name="viewport"来限制页面是否可缩放。窗口设置为不可缩放(scalable:false)时,用户不可通过双指操作放大或缩小页面,即使页面中的meta节点也无法开启可缩放功能。窗口的默认值为可缩放(scalable:true)。
scrollIndicator: (DOMString类型)窗口是否显示滚动条用于控制窗口滚动条样式,可取值:"all":垂直和水平滚动条都显示,"vertical":仅显示垂直,"horizontal":仅显示水平滚动条,"none":垂直和水平滚动条都不显示。默认值为"all",即垂直和水平滚动条都显示。注意:显示滚动条的前提条件是窗口中的内容超过窗口显示的宽或高。
top: (DOMString类型)窗口垂直向下的偏移量支持百分比、像素值,默认值为0px。
transition: (Transition类型)窗口定义窗口变换的动画效果,参考Transitiontransform: (Transform类型)窗口定义窗口变形效果,参考Transformwidth: (DOMString类型)窗口的宽度支持百分比、像素值,默认为100%。
zindex: (Number类型)窗口的堆叠顺序值拥有更高堆叠顺序的窗口总是会处于堆叠顺序较低的窗口的前面,拥有相同堆叠顺序的窗口后调用show方法则在前面。
PullToRefreshOptionJSON对象,原生窗口设置参数的对象
属性:support: (Boolean类型)是否开启下拉刷新功能true表示开启下拉刷新功能,false表示关闭下拉刷新功能,默认值为true。
height: (String类型)下拉刷新控件的高度当用户下拉操作的高度大于或等于此值事,松开后则进入刷新状态。可支持像素值和百分比,像素值为绝对值,以px结尾;百分比相对窗口的高度,以%结尾;如“60px”、“10%”,默认值为“100px”。注:当下拉的高度大于等于刷新控件的高度时,控件居底显示。
range: (String类型)下拉刷新控件可下拉的最大高度用户可下拉的最大高度,此值必须大于height值,否则将会导致无法触发刷新事件。可支持像素值和百分比,像素值为绝对值,以px结尾;百分比相对窗口的高度,以%结尾;如“60px”、“10%”,默认值为height值。
contentdown: (JSON类型)下拉刷新控件在下拉状态时显示的内容仅支持caption字段,用于设置下拉状态时显示的文本内容。
contentover: (JSON类型)下拉刷新控件在达到可刷新状态时显示的内容仅支持caption字段,用于设置可刷新状态时显示的文本内容。
contentrefresh: (JSON类型)下拉刷新控件正在刷新状态时显示的内容仅支持caption字段,用于设置在刷新状态时显示的文本内容。
平台支持:Android- 2.2+(支持)iOS- 4.5+(不支持): 暂不支持,建议通过html技术实现TimeOptionJSON对象,选择时间界面设置的参数
属性:title: (DOMString类型)时间选择操作界面显示的标题字符串类型,默认标题为当前选择的时间。
is24Hour: (Boolean类型)是否24小时制模式,默认值为truepopover: (JSON类型)时间日期选择界面弹出指示区域JSON对象,格式如{top:10;left:10;width:200;height:200;},所有值为像素值,左上坐标相对于容器webview的位置。如未设置此值,默认在屏幕居中显示。
平台支持Android - 2.2+ (不支持)iOS - 4.3+ (支持): 仅在iPad上有效,在iPhone上忽略此值。ToastOptionJSON对象,系统提示消息框要设置的参数
属性:icon: (DOMString类型)提示消息框上显示的图标duration: (DOMString类型)提示消息框显示的时间可选值为"long"、"short",值为"long"约为3.5s,值为"short"时约为2s,默认值为"short"。
align: (DOMString类型)提示消息框在屏幕中的水平位置可选值为"left"、"center"、"right",分别为水平居左、居中、居右,默认值为"center"。
verticalAlign: (DOMString类型)提示消息框在屏幕中的垂直位置可选值为"top"、"center"、"bottom",分别为垂直居顶、居中、居底,默认值为"bottom"。
Transform一组用于定义页面或控件变形的属性,暂不支持
属性:rotate: (DOMString类型)暂不支持translate: (DOMString类型)暂不支持scale: (DOMString类型)暂不支持skew: (DOMString类型)暂不支持matrix: (DOMString类型)暂不支持Transition一组用于定义页面或控件转换效果的属性
属性:property: (DOMString类型)产生变换效果的属性默认值为"all",暂不支持其它值。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)duration: (DOMString类型)变换持续的时间默认值为0,即无动画效果。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)timingfunction: (DOMString类型)窗口变换效果可取值linear、ease-in、ease-out、ease-in-out,默认值为linear。
平台支持Android - 2.2+ (支持)iOS - 4.3+ (支持)AlertCallback系统提示框确认的回调函数
void onAlerted() {// Alert handled code.}参数:无
返回值:void: 无ConfirmCallback系统确认框操作的回调函数
void onConfirmed( Number index ) {// Confirm handled code.}参数:index: (Number)必选 用户点击按钮的索引值,从0开始返回值:void: 无平台支持:Android- 2.2+(支持): 用户点击“返回”按钮则提示框消失,同时回调函数返回的index值为-1。iOS- 4.3+(支持)PromptCallback系统输入框操作的回调函数
function void onPrompted( Number index, DOMString value ) {// Prompt handled code.}参数:index: (Number)必选 用户点击按钮的索引值,从0开始value: (DOMString)可选 用户输入的内容,若没有输入则返回空字符串返回值:void: 无平台支持:Android- 2.2+(支持): 用户点击“返回”按钮则提示框消失,同时回调函数返回的index值为-1,value值为空字符串。iOS- 4.3+(支持)ToastCallback系统消息框消失时的回调函数
void onToast() {// Toast close handled code.}参数:无
返回值:void: 无PickDatetimeSuccessCallback选择日期或时间操作成功的回调函数
function void onPickSuccess( DOMDate date ) {// Date picked code.}参数:date: (DOMDate)必选 用户选择的日期或时间数据若调用的是日期选择操作则仅年、月、日信息有效,若调用的是时间选择操作则仅时、分信息有效。返回值:void: 无PickDatetimeErrorCallback选择日期或时间操作失败的回调函数
function void onPickError( DOMException error ) {// Date picked error.alert( error.message );}参数:error: (DOMException)必选 用户选择操作失败信息返回值:void: 无MetricsCallback获取控件或窗口实际度量信息回调函数
void onMetricsCompleted( Metrics metrics ) {// Get metrics completed code.}参数:metrics: (Metrics)必选 获取到的窗口或控件的度量信息,参考Metrics返回值:void: 无EventCallback窗口事件的回调函数
void onEvent() {// Event handled code.}参数:无
返回值:void: 无HistoryQueryCallback历史记录记录查询的回调函数
void onQuery( able ) {// Event handled code.}参数:able: (Boolean)必选 历史记录操作是否可用,true表示可用,false表示不可用返回值:void: 无PullToRefreshCallback窗口刷新操作的回调函数
void onRefresh() {// Event handled code.}参数:无
返回值:void: 无